home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / editor / words3.lha / Words / SpellIT / Manual < prev    next >
Text File  |  1995-08-06  |  8KB  |  175 lines
  1.                                    SPELLIT
  2.  
  3. SpellIt is a spell checker for GoldED. It is  based  on  the  ISpell  package
  4. available  for  several  machines  including the PC and Amiga (thus providing
  5. access to existing dictionaries). SpellIT  is  not  language-dependent:  just
  6. load a dictionary file you are interested in. ISpell (including a dictionary)
  7. is freeware; it has been released on a Fish disk.
  8.  
  9.  FEATURES:
  10.  
  11.    o ability to check existing files
  12.    o fast online checking while typing
  13.    o suggests replacements
  14.    o localized
  15.    o user dictionary, extendable
  16.    o fully integrated into the GoldED environment
  17.  
  18.  
  19.                                 INSTALLATION
  20.  
  21.  
  22. Run the Words install script to have ISpell, SpellIT, the dictionaries and  a
  23. syntax   parser   installed.   The  installer  script  modifies  your  GoldED
  24. configuration: it adds SpellIT to the list of API clients and  it  loads  the
  25. WarpSPELL  syntax  parser. You should save the new configuration if you don't
  26. want to loose the changes.
  27.  
  28. Once installed, SpellIT will launch ISpell and (if ISpell has  been  launched
  29. successfully)  add  a  new  SPELL  command  to GoldED's command set. Use this
  30. command as if it were an internal editor command:  assign  it  to  menus,  to
  31. keyboard  events, use it within the command requester or within ARexx macros.
  32. Ready-to-use presets (a menu preset and a  keyboard  preset)  are  available;
  33. they are described later on. The SPELL syntax according to AmigaDOS rules:
  34.  
  35.  Description of the SPELL command
  36.  
  37.  command    option       description
  38.  --------------------------------------------------------------------------
  39.  SPELL      ABOUT/S      display copyright information related to SpellIT
  40.             ONLINE/K     turn online spell checking on/off
  41.             ASK/K        online checking: display suggestions ?
  42.             NEXT/S       move to next error
  43.             SUGGEST/S    show suggestions related to word under cursor
  44.             VOLUME/N     error beep volume (0...63)
  45.             ADD/S        add word under cursor to user dictionary
  46.             CURRENT/S    check word
  47.             TEX/K        ignore words introduced by "\" (TeX style commands)
  48.  
  49. The option type is described by the slash/letter combinations appended to the
  50. option  name  (you  may use a combination of several options): \S options are
  51. switches, turning a feature <on> if they are given  at  all.  They  are  used
  52. without  further  arguments. \K options are different: they require arguments
  53. (either TRUE, FALSE or TOGGLE): Example: SPELL ONLINE=TRUE. \K  options  turn
  54. features <on> or <off> according to the provided argument. Finally, there are
  55. \N options - they are used to pass numerical values (e.g.  SPELL  VOLUME=20).
  56. Example (combined options):
  57.  
  58. Open GoldED's command requester (misc menu) and enter SPELL CURRENT  ASK=TRUE
  59. to  make  SpellIT  check  the  word  under  the  cursor and display a list of
  60. suggested replacements if the spelling is rated wrong or unknown.
  61.  
  62.  
  63.                                    MENU
  64.  
  65. SpellIT is distributed with a ready-to-use menu preset (SpellIT_E.men):  Open
  66. GoldED's menu requester and append that menu file to your current menus using
  67. the <append> gadget. The new 'SpellIT' menu features the following entries:
  68.  
  69.                             -----------------
  70.                             |about SpellIT  |
  71.                             |---------------|
  72.                             |next error     |
  73.                             |check word     |
  74.                             |---------------|
  75.                             |learn word     |
  76.                             |refresh display|
  77.                             |---------------|
  78.                             |\/ online check|
  79.                             |\/ suggestions |
  80.                             |---------------|
  81.                             |error beep     |
  82.                             -----------------
  83.  
  84. ABOUT SPELLIT
  85.  
  86. Displays copyright and  version  information  related  to  SpellIT.  Besides,
  87. you'll  find  an  e-mail  address  providing GoldED support. Check the GoldED
  88. manual for details.
  89.  
  90. NEXT ERROR
  91.  
  92. Move cursor to next error. If there is no further error (beware :-)  a  short
  93. note  pops  up.  Folded  lines are not scanned for errors. Unfold them if you
  94. want to have them considered.
  95.  
  96. CHECK WORD
  97.  
  98. Checks the current word. Issues a beep if it is considered to be  misspelled.
  99. If  you have asked for replacement suggestions (see SUGGESTIONS below) and if
  100. ISpell is able to provide some, a list pops up. Use the cursor keys  to  move
  101. within  the  list.  Use  <RETURN> to accept a selection respectively <ESC> to
  102. quit without selection.
  103.  
  104. LEARN WORD
  105.  
  106. Adds the word under the cursor to the user dictionary. Words are added to the
  107. online  dictionary  in  RAM  and  not saved to the disk based user dictionary
  108. immediately. However, during closedown of SpellIT (SpellIT is closed down  if
  109. you  leave  GoldED) you are asked wether you want to have the new words added
  110. to the disk based dictionary, too.
  111.  
  112. REFRESH DISPLAY
  113.  
  114. This menu won't be of any use unless you have installed the WarpSPELL  syntax
  115. parser  (available  at  the support BBS). The WarpSPELL parser highlights all
  116. unknown words found within a text. Use this menu  after  having  learned  new
  117. words to make the editor refresh the highlighting scheme and thus reflect the
  118. dictionary changes.
  119.  
  120. ONLINE CHECK
  121.  
  122. Turns online spell checking on respectively off (SpellIT  utilizes  the  user
  123. variable  USER19  of  GoldED  to  remember  the  current mode). Your input is
  124. spellchecked while typing if  online  checking  is  enabled:  Once  you  have
  125. entered  a word, ISpell has a look at it. A word is considered 'entered' if a
  126. white space character reaches GoldED (including  space,  colon,  and  several
  127. more).  You should enter a space even after the last word of a line to ensure
  128. a check (or switch the editor to word wrap mode and  don't  use  <return>  at
  129. all).  Errors  are  announced  by  a beep and (if SUGGESTIONS is active ; see
  130. below) a list of replacement suggestions.
  131.  
  132. SUGGESTIONS
  133.  
  134. Turns generations of replacement suggestions  <on>  respectively  <off>  (see
  135. CHECK  CURRENT  and  ONLINE  CHECK  above).  SpellIT  utilizes  GoldED's user
  136. variable USER20 to remember the current mode.
  137.  
  138. ERROR BEEP
  139.  
  140. Sets the error beep volume. The OS function  DisplayBeep()  is  used  if  the
  141. error beep is turned off completely (volume = 0), usually causing the display
  142. to flash.
  143.  
  144.                                @{Keyboard}
  145.  
  146. Keyboard assignments of  several  function  keys  have  been  changed  during
  147. SpellIT  installation  (if  requested)  to  provide  fast  access  to the new
  148. features of SpellIT. Keyboard shortcuts are handled  much  faster  by  GoldED
  149. than  menu  selections due to the way menu selections are buffered by the OS.
  150. New keyboard assignments:
  151.  
  152.                 F6 ............ online spell checking ON
  153.           SHIFT-F6 ............ online spell checking OFF
  154.                 F7 ............ move cursor to next error
  155.                 F8 ............ check word under cursor
  156.                 F9 ............ learn word under cursor
  157.                 F10 ........... normal error beep
  158.           SHIFT-F10 ........... low beep
  159.  
  160.  
  161.                                    AUTHOR
  162.  
  163. Feel free to e-mail me bug reports, comments or suggestions.  Current  e-mail
  164. address  is  DIETMAR@TOMATE.TNG.OCHE.DE.  Don't  send  me  normal  letters. I
  165. wouldn't have the time to answer them. I don't offer updates on disks,  check
  166. your local BBS instead. Disks reaching me are put to a good cause (preferably
  167. backups :-).
  168.  
  169. Dietmar Eilert
  170. Mies-v-d-Rohe-Str.31, 52074 Aachen, Germany
  171. E-Mail: DIETMAR@TOMATE.TNG.OCHE.DE
  172. Tel: +49-(0)241-81665
  173.      +49-(0)2525-7776
  174. Fax: +49-(0)241-81665
  175.